package com.sgs.carbon.web.modules.common.dal.dataobject.auth;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.sgs.carbon.starter.mybatis.core.dataobject.BaseDO;
import com.sgs.carbon.starter.security.core.LoginUser;
import com.sgs.carbon.web.modules.common.dal.dataobject.user.SysUserDO;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;

import java.util.Date;

/**
 * 在线用户表</br>
 * <p>
 *     我们已经将 {@link LoginUser} 缓存在 Redis 当中, 这里额外存储在线用户到 MySQL 中, 目的是为了方便管理界面可以灵活查询。
 *     同时, 通过定时轮询 SysUserSessionDO 表, 可以主动删除 Redis 的缓存, 因为 Redis 的过期删除是延迟的。
 * </p>
 *
 * @author Dave Liu
 * @date 2021-10-06
 */
@Data
@Builder
@EqualsAndHashCode(callSuper = true)
@TableName(value = "sys_user_session", autoResultMap = true)
public class SysUserSessionDO extends BaseDO {

    /**
     * 会话编号, 即 sessionId
     */
    @TableId(type = IdType.INPUT)
    private String id;

    /**
     * 用户编号
     *
     * 关联 {@link SysUserDO#getId()}
     */
    private Long userId;

    /**
     * 用户账号
     *
     * 冗余, 因为账号可以变更
     */
    private String username;

    /**
     * 用户 IP
     */
    private String userIp;

    /**
     * 浏览器 UA
     */
    private String userAgent;

    /**
     * 会话超时时间
     */
    private Date sessionTimeout;

}
